Clarify carryoverConcurrencyCount documentation
#100
Conversation
Updates `carryoverConcurrencyCount` documentation as discussed in issue #99 .
readme.md
Outdated
| @@ -105,7 +105,7 @@ The length of time in milliseconds before the interval count resets. Must be fin | |||
| Type: `boolean`\ | |||
| Default: `false` | |||
|
|
|||
| Whether the task must finish in the given interval or will be carried over into the next interval count. | |||
| If `true`, specifies that an incomplete `Promise` should be carried over into the next interval and counted against the `intervalCap`. If `false`, an incomplete promise will continue to run independent of the next interval and will not count towards the `intervalCap`. | |||
There was a problem hiding this comment.
What do you mean by incomplete?
There was a problem hiding this comment.
A promise that has started executing but hasn't settled yet.
There was a problem hiding this comment.
@Rafael09ED Can you clarify in the text what you mean by "incomplete" or even better, use a better term than "Incomplete".
There was a problem hiding this comment.
How's:
If true, specifies that any pending Promises, should be carried over into the next interval and counted against the intervalCap. If false, any of those pending Promises will not count towards the next intervalCap.
|
@Rafael09ED Bump |
|
Do I need to merge |
|
All good :) |
Updates
carryoverConcurrencyCountdocumentation as discussed in issue #99 .